Help

Syntax: @Help {helpfile/Context_Identity}

The Help command can be used in two ways; either being followed by a help filename, or by a help topic Context_ID number.

Setting the Help file to be used

When followed by a literal string or variable, the Help command can be used to control which help is called from within XpertRule when the user presses any subsequent help buttons. The developer can specify the help file to be used and create application specific help systems. An alternative way of setting the default help file is to use the HelpFile property of the Knowledge Module's information.

The variable or literal helpfile specifies the help file name (and path name) that will be passed to WINHELP. The default location for the help file is the same directory as the application.

Once set, the helpfile remains unchanged until it is altered by another @Help helpfile command.

Example

@HELP 'Help.hlp'

Sets the help file to 'help.hlp' which should typically be present in the same sub directory as the application.

Invoking WINHELP

When followed by a numeric literal or numeric variable, the Help command can be used to invoke WINHELP (the Windows help executable program) and pass a context identity topic reference.

Example:

@HELP 1002

Calls WINHELP and passes the value 1002 to the help system. If Topic 1002 does not exist, a help not available message would appear.

Sources of information

·For further general information on HELP systems, see documents such as BORLAND LANGUAGES HELP COMPILER reference or the MICROSOFT SYSTEM DEVELOPERS KIT (SDK).

·See the white paper called Building Hypertext Help Systems on the XpertRule Software web site at http://www.xpertrule.com/pages/dev_hlp.htm.